# Copyright 2019 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# NOTE: This file is auto generated by the elixir code generator program.
# Do not edit this file manually.

defmodule GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Fact do
  @moduledoc """
  The fact used in grounding.

  ## Attributes

  *   `query` (*type:* `String.t`, *default:* `nil`) - Query that is used to retrieve this fact.
  *   `score` (*type:* `float()`, *default:* `nil`) - If present, according to the underlying Vector DB and the selected metric type, the score can be either the distance or the similarity between the query and the fact and its range depends on the metric type. For example, if the metric type is COSINE_DISTANCE, it represents the distance between the query and the fact. The larger the distance, the less relevant the fact is to the query. The range is [0, 2], while 0 means the most relevant and 2 means the least relevant.
  *   `summary` (*type:* `String.t`, *default:* `nil`) - If present, the summary/snippet of the fact.
  *   `title` (*type:* `String.t`, *default:* `nil`) - If present, it refers to the title of this fact.
  *   `uri` (*type:* `String.t`, *default:* `nil`) - If present, this uri links to the source of the fact.
  *   `vectorDistance` (*type:* `float()`, *default:* `nil`) - If present, the distance between the query vector and this fact vector.
  """

  use GoogleApi.Gax.ModelBase

  @type t :: %__MODULE__{
          :query => String.t() | nil,
          :score => float() | nil,
          :summary => String.t() | nil,
          :title => String.t() | nil,
          :uri => String.t() | nil,
          :vectorDistance => float() | nil
        }

  field(:query)
  field(:score)
  field(:summary)
  field(:title)
  field(:uri)
  field(:vectorDistance)
end

defimpl Poison.Decoder, for: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Fact do
  def decode(value, options) do
    GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Fact.decode(value, options)
  end
end

defimpl Poison.Encoder, for: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Fact do
  def encode(value, options) do
    GoogleApi.Gax.ModelBase.encode(value, options)
  end
end
